<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensor.eclipse.addon;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.Iterator;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.List;<a name="line.4"></a>
<FONT color="green">005</FONT>    <a name="line.5"></a>
<FONT color="green">006</FONT>    import org.eclipse.jdt.core.dom.ASTVisitor;<a name="line.6"></a>
<FONT color="green">007</FONT>    import org.eclipse.jdt.core.dom.Annotation;<a name="line.7"></a>
<FONT color="green">008</FONT>    import org.eclipse.jdt.core.dom.Block;<a name="line.8"></a>
<FONT color="green">009</FONT>    import org.eclipse.jdt.core.dom.ExpressionStatement;<a name="line.9"></a>
<FONT color="green">010</FONT>    import org.eclipse.jdt.core.dom.IExtendedModifier;<a name="line.10"></a>
<FONT color="green">011</FONT>    import org.eclipse.jdt.core.dom.MethodDeclaration;<a name="line.11"></a>
<FONT color="green">012</FONT>    import org.eclipse.jdt.core.dom.MethodInvocation;<a name="line.12"></a>
<FONT color="green">013</FONT>    import org.eclipse.jdt.core.dom.Statement;<a name="line.13"></a>
<FONT color="green">014</FONT>    import org.eclipse.jdt.core.dom.TypeDeclaration;<a name="line.14"></a>
<FONT color="green">015</FONT>    <a name="line.15"></a>
<FONT color="green">016</FONT>    /**<a name="line.16"></a>
<FONT color="green">017</FONT>     * Implements a meter to measure several aspects such as number of methods, statements, test <a name="line.17"></a>
<FONT color="green">018</FONT>     * methods, assertion statements if applicable. Number of test methods, assertion statements is<a name="line.18"></a>
<FONT color="green">019</FONT>     * reported to assist Test-Driven Development study.<a name="line.19"></a>
<FONT color="green">020</FONT>     * <a name="line.20"></a>
<FONT color="green">021</FONT>     * @author Hongbing Kou<a name="line.21"></a>
<FONT color="green">022</FONT>     */<a name="line.22"></a>
<FONT color="green">023</FONT>    public class JavaStatementMeter extends ASTVisitor {<a name="line.23"></a>
<FONT color="green">024</FONT>      /** Name of this compilation unit. */<a name="line.24"></a>
<FONT color="green">025</FONT>      private String name; <a name="line.25"></a>
<FONT color="green">026</FONT>      <a name="line.26"></a>
<FONT color="green">027</FONT>      /** Number of methods. */<a name="line.27"></a>
<FONT color="green">028</FONT>      private int numOfMethods = 0;<a name="line.28"></a>
<FONT color="green">029</FONT>      /** Number of invocations. */<a name="line.29"></a>
<FONT color="green">030</FONT>      private int numOfStatements = 0;<a name="line.30"></a>
<FONT color="green">031</FONT>      <a name="line.31"></a>
<FONT color="green">032</FONT>      /** Saves number of tests if there is any. */<a name="line.32"></a>
<FONT color="green">033</FONT>      private int numOfTestMethods = 0;<a name="line.33"></a>
<FONT color="green">034</FONT>      /** Saves number of test assertions in this class if there is any. */<a name="line.34"></a>
<FONT color="green">035</FONT>      private int numOfTestAssertions = 0;<a name="line.35"></a>
<FONT color="green">036</FONT>      <a name="line.36"></a>
<FONT color="green">037</FONT>      /**<a name="line.37"></a>
<FONT color="green">038</FONT>       * Visit class type declaration to get name of this object.<a name="line.38"></a>
<FONT color="green">039</FONT>       * <a name="line.39"></a>
<FONT color="green">040</FONT>       * @param td TypeDeclaration such as class definition.<a name="line.40"></a>
<FONT color="green">041</FONT>       * @return True if continute to check child nodes. <a name="line.41"></a>
<FONT color="green">042</FONT>       */<a name="line.42"></a>
<FONT color="green">043</FONT>      public boolean visit(TypeDeclaration td) {<a name="line.43"></a>
<FONT color="green">044</FONT>        if (td.getName() != null) {<a name="line.44"></a>
<FONT color="green">045</FONT>          this.name = td.getName().getIdentifier();<a name="line.45"></a>
<FONT color="green">046</FONT>        }<a name="line.46"></a>
<FONT color="green">047</FONT>        <a name="line.47"></a>
<FONT color="green">048</FONT>        return true;<a name="line.48"></a>
<FONT color="green">049</FONT>      }<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>      <a name="line.51"></a>
<FONT color="green">052</FONT>      /**<a name="line.52"></a>
<FONT color="green">053</FONT>       * Checks whether the given method is a JUnit 4 unit test.<a name="line.53"></a>
<FONT color="green">054</FONT>       * <a name="line.54"></a>
<FONT color="green">055</FONT>       * @param md Method declaration.<a name="line.55"></a>
<FONT color="green">056</FONT>       * @return True if it is a unit test of JUnit 4. <a name="line.56"></a>
<FONT color="green">057</FONT>       */<a name="line.57"></a>
<FONT color="green">058</FONT>      private boolean isJUnit4Test(MethodDeclaration md) {<a name="line.58"></a>
<FONT color="green">059</FONT>        List modifiers = md.modifiers();<a name="line.59"></a>
<FONT color="green">060</FONT>        for (Iterator i = modifiers.iterator(); i.hasNext();) {<a name="line.60"></a>
<FONT color="green">061</FONT>          IExtendedModifier modifer = (IExtendedModifier) i.next();<a name="line.61"></a>
<FONT color="green">062</FONT>          if (modifer.isAnnotation()) {<a name="line.62"></a>
<FONT color="green">063</FONT>            Annotation annotation = (Annotation) modifer;<a name="line.63"></a>
<FONT color="green">064</FONT>            if ("Test".equals(annotation.getTypeName().getFullyQualifiedName())) {<a name="line.64"></a>
<FONT color="green">065</FONT>              return true;<a name="line.65"></a>
<FONT color="green">066</FONT>            }<a name="line.66"></a>
<FONT color="green">067</FONT>          }<a name="line.67"></a>
<FONT color="green">068</FONT>        }<a name="line.68"></a>
<FONT color="green">069</FONT>        <a name="line.69"></a>
<FONT color="green">070</FONT>        return false;<a name="line.70"></a>
<FONT color="green">071</FONT>      }<a name="line.71"></a>
<FONT color="green">072</FONT>      <a name="line.72"></a>
<FONT color="green">073</FONT>      <a name="line.73"></a>
<FONT color="green">074</FONT>      /**<a name="line.74"></a>
<FONT color="green">075</FONT>       * Visits the method invocation to get number of assertion in this test method.<a name="line.75"></a>
<FONT color="green">076</FONT>       * <a name="line.76"></a>
<FONT color="green">077</FONT>       * @param md Visit method declaration in source code.<a name="line.77"></a>
<FONT color="green">078</FONT>       * @return False because we don't look into child nodes. <a name="line.78"></a>
<FONT color="green">079</FONT>       */<a name="line.79"></a>
<FONT color="green">080</FONT>      public boolean visit(MethodDeclaration md) {<a name="line.80"></a>
<FONT color="green">081</FONT>        if (md.getName() != null) {<a name="line.81"></a>
<FONT color="green">082</FONT>          this.numOfMethods++;<a name="line.82"></a>
<FONT color="green">083</FONT>          <a name="line.83"></a>
<FONT color="green">084</FONT>          if (md.getName().getIdentifier().startsWith("test")) {<a name="line.84"></a>
<FONT color="green">085</FONT>            this.numOfTestMethods++;<a name="line.85"></a>
<FONT color="green">086</FONT>          }<a name="line.86"></a>
<FONT color="green">087</FONT>          else if (isJUnit4Test(md)) {<a name="line.87"></a>
<FONT color="green">088</FONT>            this.numOfTestMethods++;<a name="line.88"></a>
<FONT color="green">089</FONT>          }<a name="line.89"></a>
<FONT color="green">090</FONT>          <a name="line.90"></a>
<FONT color="green">091</FONT>          // Check test method body to look for assertion statement. <a name="line.91"></a>
<FONT color="green">092</FONT>          Block methodBody = md.getBody();<a name="line.92"></a>
<FONT color="green">093</FONT>          if (methodBody != null &amp;&amp; methodBody.statements() != null) {<a name="line.93"></a>
<FONT color="green">094</FONT>            List stmts = methodBody.statements();<a name="line.94"></a>
<FONT color="green">095</FONT>            this.numOfStatements += stmts.size();<a name="line.95"></a>
<FONT color="green">096</FONT>            // Looks through all statements in this method body.<a name="line.96"></a>
<FONT color="green">097</FONT>            for (Iterator i = stmts.iterator(); i.hasNext();) {<a name="line.97"></a>
<FONT color="green">098</FONT>              Statement stmt = (Statement) i.next();<a name="line.98"></a>
<FONT color="green">099</FONT>              // MethodInvocation is one kind of expression statement.<a name="line.99"></a>
<FONT color="green">100</FONT>              if (stmt instanceof ExpressionStatement) {<a name="line.100"></a>
<FONT color="green">101</FONT>                ExpressionStatement estmt = (ExpressionStatement) stmt;<a name="line.101"></a>
<FONT color="green">102</FONT>                checkAssertions(estmt);<a name="line.102"></a>
<FONT color="green">103</FONT>              }<a name="line.103"></a>
<FONT color="green">104</FONT>            }<a name="line.104"></a>
<FONT color="green">105</FONT>          }<a name="line.105"></a>
<FONT color="green">106</FONT>        }<a name="line.106"></a>
<FONT color="green">107</FONT>            <a name="line.107"></a>
<FONT color="green">108</FONT>        //No need to visit child nodes anymore.<a name="line.108"></a>
<FONT color="green">109</FONT>        return false;<a name="line.109"></a>
<FONT color="green">110</FONT>      }<a name="line.110"></a>
<FONT color="green">111</FONT>    <a name="line.111"></a>
<FONT color="green">112</FONT>      /**<a name="line.112"></a>
<FONT color="green">113</FONT>       * Check expression statement for test assertions.<a name="line.113"></a>
<FONT color="green">114</FONT>       * <a name="line.114"></a>
<FONT color="green">115</FONT>       * @param estmt Expression statements.<a name="line.115"></a>
<FONT color="green">116</FONT>       */<a name="line.116"></a>
<FONT color="green">117</FONT>      private void checkAssertions(ExpressionStatement estmt) {<a name="line.117"></a>
<FONT color="green">118</FONT>        if (estmt.getExpression() instanceof MethodInvocation) {<a name="line.118"></a>
<FONT color="green">119</FONT>          MethodInvocation mi = (MethodInvocation) estmt.getExpression();<a name="line.119"></a>
<FONT color="green">120</FONT>          // Increment number of test assertions.<a name="line.120"></a>
<FONT color="green">121</FONT>          if (mi.getName() != null &amp;&amp; mi.getName().getIdentifier().startsWith("assert")) {<a name="line.121"></a>
<FONT color="green">122</FONT>            this.numOfTestAssertions++;<a name="line.122"></a>
<FONT color="green">123</FONT>          }<a name="line.123"></a>
<FONT color="green">124</FONT>        }<a name="line.124"></a>
<FONT color="green">125</FONT>      }<a name="line.125"></a>
<FONT color="green">126</FONT>      /**<a name="line.126"></a>
<FONT color="green">127</FONT>       * Gets number of methods.<a name="line.127"></a>
<FONT color="green">128</FONT>       * <a name="line.128"></a>
<FONT color="green">129</FONT>       * @return Number of methods.<a name="line.129"></a>
<FONT color="green">130</FONT>       */<a name="line.130"></a>
<FONT color="green">131</FONT>      public int getNumOfMethods() {<a name="line.131"></a>
<FONT color="green">132</FONT>        return this.numOfMethods;<a name="line.132"></a>
<FONT color="green">133</FONT>      }<a name="line.133"></a>
<FONT color="green">134</FONT>      <a name="line.134"></a>
<FONT color="green">135</FONT>      /**<a name="line.135"></a>
<FONT color="green">136</FONT>       * Gets number of statements.<a name="line.136"></a>
<FONT color="green">137</FONT>       * <a name="line.137"></a>
<FONT color="green">138</FONT>       * @return Number of statements.<a name="line.138"></a>
<FONT color="green">139</FONT>       */<a name="line.139"></a>
<FONT color="green">140</FONT>      public int getNumOfStatements() {<a name="line.140"></a>
<FONT color="green">141</FONT>        return this.numOfStatements;<a name="line.141"></a>
<FONT color="green">142</FONT>      }<a name="line.142"></a>
<FONT color="green">143</FONT>      <a name="line.143"></a>
<FONT color="green">144</FONT>      /**<a name="line.144"></a>
<FONT color="green">145</FONT>       * Gets number of tests.<a name="line.145"></a>
<FONT color="green">146</FONT>       * <a name="line.146"></a>
<FONT color="green">147</FONT>       * @return Number of test.<a name="line.147"></a>
<FONT color="green">148</FONT>       */<a name="line.148"></a>
<FONT color="green">149</FONT>      public int getNumOfTestMethods() {<a name="line.149"></a>
<FONT color="green">150</FONT>        return this.numOfTestMethods;<a name="line.150"></a>
<FONT color="green">151</FONT>      }<a name="line.151"></a>
<FONT color="green">152</FONT>      <a name="line.152"></a>
<FONT color="green">153</FONT>      /**<a name="line.153"></a>
<FONT color="green">154</FONT>       * Gets number of test assertion statements.<a name="line.154"></a>
<FONT color="green">155</FONT>       * <a name="line.155"></a>
<FONT color="green">156</FONT>       * @return Number of assertion statements<a name="line.156"></a>
<FONT color="green">157</FONT>       */<a name="line.157"></a>
<FONT color="green">158</FONT>      public int getNumOfTestAssertions() {<a name="line.158"></a>
<FONT color="green">159</FONT>        return this.numOfTestAssertions;<a name="line.159"></a>
<FONT color="green">160</FONT>      }<a name="line.160"></a>
<FONT color="green">161</FONT>      <a name="line.161"></a>
<FONT color="green">162</FONT>      /**<a name="line.162"></a>
<FONT color="green">163</FONT>       * Check whether this compilation unit has test. <a name="line.163"></a>
<FONT color="green">164</FONT>       * <a name="line.164"></a>
<FONT color="green">165</FONT>       * @return True if it has any test method or assertion.<a name="line.165"></a>
<FONT color="green">166</FONT>       */<a name="line.166"></a>
<FONT color="green">167</FONT>      public boolean hasTest() {<a name="line.167"></a>
<FONT color="green">168</FONT>        return this.numOfTestMethods &gt; 0 || this.numOfTestAssertions &gt; 0;   <a name="line.168"></a>
<FONT color="green">169</FONT>      }<a name="line.169"></a>
<FONT color="green">170</FONT>      <a name="line.170"></a>
<FONT color="green">171</FONT>      /**<a name="line.171"></a>
<FONT color="green">172</FONT>       * Returns meter values in string.<a name="line.172"></a>
<FONT color="green">173</FONT>       * <a name="line.173"></a>
<FONT color="green">174</FONT>       * @return Metrics value string. <a name="line.174"></a>
<FONT color="green">175</FONT>       */<a name="line.175"></a>
<FONT color="green">176</FONT>      public String toString() {<a name="line.176"></a>
<FONT color="green">177</FONT>        StringBuffer buf = new StringBuffer(200);<a name="line.177"></a>
<FONT color="green">178</FONT>        buf.append("*****  ").append(this.name).append("   *****\nMethods     : ")<a name="line.178"></a>
<FONT color="green">179</FONT>        .append(this.numOfMethods).append("\nStatements  : ").append(this.numOfStatements);<a name="line.179"></a>
<FONT color="green">180</FONT>            <a name="line.180"></a>
<FONT color="green">181</FONT>        // Appends test info if there is any.<a name="line.181"></a>
<FONT color="green">182</FONT>        if (this.hasTest()) {<a name="line.182"></a>
<FONT color="green">183</FONT>           buf.append("\nTests       : ").append(this.numOfTestMethods);<a name="line.183"></a>
<FONT color="green">184</FONT>           buf.append("\nAssertions  : ").append(this.numOfTestAssertions);<a name="line.184"></a>
<FONT color="green">185</FONT>        }<a name="line.185"></a>
<FONT color="green">186</FONT>        <a name="line.186"></a>
<FONT color="green">187</FONT>        return buf.toString();<a name="line.187"></a>
<FONT color="green">188</FONT>      }<a name="line.188"></a>
<FONT color="green">189</FONT>    }<a name="line.189"></a>




























































</PRE>
</BODY>
</HTML>
